<!-- HTML header for doxygen 1.8.5-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<title>GenAVB/TSN: Frame Preemption API usage</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script src="http://www.freescale.com/files/abstract/misc/COLLATERALTEMPLATE_infocenter.js" type="text/javascript" xml:space="preserve"><!-- --></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="html_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="nxp_logo.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">GenAVB/TSN
   </div>
  </td>
   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
</td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('frame_preemption_usage.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="PageDoc"><div class="header">
  <div class="headertitle">
<div class="title">Frame Preemption API usage </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This API is used to configure the frame preemption feature (as defined in IEEE 802.3br-2016 and IEEE 802.1Qbu-2016) of a given network port. Frame preemption allows Express traffic to interrupt on-going Preemptable traffic. Preemption can be enabled or disabled at the port level. Frame priorities can be configured as either Preemptable or Express.</p>
<p>This feature requires specific hardware support and returns an error if the corresponding network port doesn't support it.</p>
<p>The 802.1Q configuration is set using <a class="el" href="group__qos.html#gaf89a8f18d8cc0c72d73ddadec6974c31" title="Sets Frame Preemption configuration for a given logical port.">genavb_fp_set</a>:</p><ul>
<li>port_id: the logical port ID.</li>
<li>type: the <a class="el" href="group__qos.html#gaa9e2484ac281cbe027e5c2d4c3abb39f">genavb_fp_config_type_t</a> configuration type. Must be set to <a class="el" href="group__qos.html#ggaa9e2484ac281cbe027e5c2d4c3abb39fa6d90b97901d8bc67862334580a1ff433" title="802.1Q configuration">GENAVB_FP_CONFIG_802_1Q</a>.</li>
<li>config: the <a class="el" href="group__qos.html#structgenavb__fp__config">genavb_fp_config</a> configuration. Only the write members of the <a class="el" href="group__qos.html#structgenavb__fp__config__802__1_q">genavb_fp_config_802_1Q</a> union should be set.</li>
</ul>
<p>Frame priorities mapped to the same Traffic class must have the same Preemptable/Express setting.</p>
<p>The 802.1Q configuration is retrieved using <a class="el" href="group__qos.html#ga101b5c16244d0c4e611e4ab379149f8c" title="Gets Frame Preemption configuration for a given logical port.">genavb_fp_get</a>:</p><ul>
<li>port_id: the logical port ID.</li>
<li>type: the <a class="el" href="group__qos.html#gaa9e2484ac281cbe027e5c2d4c3abb39f">genavb_fp_config_type_t</a> configuration type. Must be set to <a class="el" href="group__qos.html#ggaa9e2484ac281cbe027e5c2d4c3abb39fa6d90b97901d8bc67862334580a1ff433" title="802.1Q configuration">GENAVB_FP_CONFIG_802_1Q</a>.</li>
<li>config: the <a class="el" href="group__qos.html#structgenavb__fp__config">genavb_fp_config</a> configuration. Only the read members of the <a class="el" href="group__qos.html#structgenavb__fp__config__802__1_q">genavb_fp_config_802_1Q</a> union will be set when the function returns.</li>
</ul>
<p>The 802.3 configuration is set using <a class="el" href="group__qos.html#gaf89a8f18d8cc0c72d73ddadec6974c31" title="Sets Frame Preemption configuration for a given logical port.">genavb_fp_set</a>:</p><ul>
<li>port_id: the logical port ID.</li>
<li>type: the <a class="el" href="group__qos.html#gaa9e2484ac281cbe027e5c2d4c3abb39f">genavb_fp_config_type_t</a> configuration type. Must be set to <a class="el" href="group__qos.html#ggaa9e2484ac281cbe027e5c2d4c3abb39fa1d0d2e702d881f1505f7a2a586d29ecb" title="802.3 configuration">GENAVB_FP_CONFIG_802_3</a>.</li>
<li>config: the <a class="el" href="group__qos.html#structgenavb__fp__config">genavb_fp_config</a> configuration. Only the write members of the <a class="el" href="group__qos.html#structgenavb__fp__config__802__3">genavb_fp_config_802_3</a> union should be set.</li>
</ul>
<p>If verification is enabled (verify_disable_tx == false), only after the verification process is complete successfully (status_verify == <a class="el" href="group__qos.html#gga4fabd0e797a53fd22b1aeba4ffe3bbdea4b9b0a4e7f362acfa3239ed9abed2709" title="Succeeded state.">GENAVB_FP_STATUS_VERIFY_SUCCEEDED</a>), is frame preemption enabled in the port.</p>
<p>In the current release, Frame Preemption can not be enabled at the same time as Scheduled Traffic.</p>
<p>The 802.3 configuration is retrieved using <a class="el" href="group__qos.html#ga101b5c16244d0c4e611e4ab379149f8c" title="Gets Frame Preemption configuration for a given logical port.">genavb_fp_get</a>:</p><ul>
<li>port_id: the logical port ID.</li>
<li>type: the <a class="el" href="group__qos.html#gaa9e2484ac281cbe027e5c2d4c3abb39f">genavb_fp_config_type_t</a> configuration type. Must be set to <a class="el" href="group__qos.html#ggaa9e2484ac281cbe027e5c2d4c3abb39fa1d0d2e702d881f1505f7a2a586d29ecb" title="802.3 configuration">GENAVB_FP_CONFIG_802_3</a>.</li>
<li>config: the <a class="el" href="group__qos.html#structgenavb__fp__config">genavb_fp_config</a> configuration. Only the read members of the <a class="el" href="group__qos.html#structgenavb__fp__config__802__3">genavb_fp_config_802_3</a> union will be set when the function returns. </li>
</ul>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.5-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul class="foot">
    <li class="footer"> &copy; 2017-2020 NXP
    </li>
  </ul>
</div>
</body>
</html>
